Balance Contribution Report Templates

A valid report template file is required to exist in the CygNet\Services\FMS\ReportTemplates folder on your host server in order to run the command to build a Balance Contribution Report.

See Balance Contribution Report for more information about the report command that utilizes this template.

See Managing Report Definitions for information about the report definitions that reference report template files.

See Using the Reports Control for information about viewing, saving, printing or emailing reports.

Building a Balance Contribution Report Template

CygNet provides a sample report template file BalanceContributionTemplate.xlsx for reference. It is stored in the CygNet\Services\FMS\ReportTemplates\Samples folder on your host server. The information provided below contains tables listing available parameters and token sets applicable for this report. See Managing Report Template Files for information about creating, editing report template files.

Balance Contribution report templates contain a ReportDefinition page and a ReportSheet page, that together describe the reports you can produce.

The ReportDefinition sheet includes the following parameters to describe the type of report to build.

ReportParameters
Worksheet

The ReportSheet sheet includes the following sections and corresponding tokens to describe the specific format of the report to build. Valid tokens will be replaced by the values they represent. You may also include additional information you wish to see in the report.

Header
Received Report Label
Received Data Table Header
Received Data Table
Received Data Table Footer
Delivered Report Label
Delivered Data Table Header
Delivered Data Table
Delivered Data Table Footer
Report Summary
Report Footer

Displaying Additional (Non-Token) Values

You can enter additional (non-token) elements such as logos, labels, or text into reports. Elements that are not valid token values will be displayed as entered.

Note: This means that tokens with typographical errors, therefore not "valid" tokens, will also be displayed as entered.

Example

[Volume] is a valid token. If you use [Vol] (not a valid token) instead of [Volume], the value will be displayed as "[Vol]" instead of displaying the volume value desired, since [Vol] is not a valid token.

[Vol]

Configuring the ReportDefinition

The ReportDefinition uses parameters to describe the type of report for the service to build. The following parameters determine the described characteristics of your report.

Balance Contribution Report: ReportParameters

Report parameters, which appear between #ReportParameters# and #End#, can be defined by the following values.

Parameter	Description	Value
ReportName	The value defined in this cell will be used for the report name, as it will appear in drop-down menus in FMS Explorer and CygNet Explorer. See Using the Reports Control and Scheduling FMS Command Tasks in the MSS for more information.	Enter a value to be used for the report name. Example Balance Contribution
CommandName	The value defined in this cell will be used by the service to determine which specific report command type to execute. See FMSClient Methods in the Scripting section for more information.	Enter a value to specify the report command name. Example CNBAL Note: Maximum of 7 characters; letters or numbers only, no spaces.

Parameter

Description

Value

ReportName

The value defined in this cell will be used for the report name, as it will appear in drop-down menus in FMS Explorer and CygNet Explorer.

See Using the Reports Control and Scheduling FMS Command Tasks in the MSS for more information.

Enter a value to be used for the report name.

Example

Balance Contribution

CommandName

The value defined in this cell will be used by the service to determine which specific report command type to execute.

See FMSClient Methods in the Scripting section for more information.

Enter a value to specify the report command name.

Example

CNBAL

Note: Maximum of 7 characters; letters or numbers only, no spaces.

Balance Contribution Report: Worksheet Parameters

Balance Contribution report worksheet parameters, which appear between #Worksheet# and #End#, can be defined by the following values.

Parameter	Description	Value
ReportType	The value defined in this cell will be used to represent the standard FMS report type you are configuring.	Enter a value to be used to indicate the type of the report. Example Balance
NullToken	The value defined in this cell will be used to represent null values in your report.	Enter a value to be used to indicate a "null value" cell in the report. Example -
PageBreaks	The value defined in this cell will be used to specify whether or not to use a page break between sections in your report. If used, will force a page break between the "Received" and "Delivered" data table sections.	Enter a value to indicate whether or not to insert a page break. Options are Yes or No. Default value is Yes.
MixedValueToken	The value defined in this cell will be used to represent mixed values in your report.	Enter a value to be used to indicate a "mixed value" cell in the report. Example [Mixed]
NoCmdGroupToken	The value defined in this cell will be used in your report to represent the value for the Group name or Group description fields when either of the following is true. command is not run against a group Node command is run against multiple group Nodes	Enter a value to be used to indicate the Group name or Group description when the command was not run against a single group Node. Example [Invalid Group]
NodeSortOrder	The value defined in this cell will be used to specify the order in which to display Node results in the report.	Enter one of the following options. Name ascending Description ascending Name descending Description descending Default value is Name ascending. This parameter is optional.
RptStDate	Note: If you use this parameter in your report template, the RptStDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Balance Contribution Report Definitions (FMS Explorer) or Reports: Balance Contribution (CygNet Explorer) for more information.	If used, enter a valid start date value for the report. RptStDate and RptEndDate must be the same configuration parameter type. Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional.
RptEndDate	Note: If you use this parameter in your report template, the RptEndDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Balance Contribution Report Definitions (FMS Explorer) or Reports: Balance Contribution (CygNet Explorer) for more information.	If used, enter a valid end date value for the report. RptStDate and RptEndDate must be the same configuration parameter type. Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional.
RptUnitSet	Note: If you use this parameter in your report template, the RptUnitSet parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Balance Contribution Report Definitions (FMS Explorer) or Reports: Balance Contribution (CygNet Explorer) for more information.	If used, enter a valid unit set value for the report. Valid unit set values defined in the service can be viewed through the Admin menu in FMS Explorer. See Configuring Unit Set Definitions for more information. This parameter is optional.

Configuring the ReportSheet

The ReportSheet uses tokens to describe the format of the report you want to run. The following tokens determine the report content, and will retrieve the corresponding values for display in your report.

Note: Enter report tokens carefully, as the tokens are case sensitive. Typographical errors (therefore not "valid" tokens) will be handled as "additional values" and displayed as entered; the non-token value will appear in your report instead of the actual value(s) the correctly entered token would have retrieved. See Displaying Additional (Non-Token) Values above for more information.

Balance Contribution Report: Header Tokens

Balance Contribution report headers, which appear above #EndReportHdr#, can be described by the following tokens.

Token	Description
[BeginDateTime]	The start date, in Contract day (C), of the requested time range for the report
[EndDateTime]	The end date, in Contract day (C), of the requested time range for the report
[GeneratedDateTime]	The time the report was generated, in Local time (L)
[TotalStationCount]	The total number of stations (or liquid device Nodes) in the report

Balance Contribution Report: Received Report Label Token

Balance Contribution report subsection labels, which appear between #SubSection# ReceivedReportLabel and #End#, can be described by the following tokens.

Token	Description
[ReceiptStationCount]	The number of stations (or liquid device Nodes) with balances received

Balance Contribution Report: Received Data Table Header Tokens

Balance Contribution report data table headers, which appear between #SubSection# ReceivedDataTableHeader and #End#, can be described by the following tokens.

Note: In PDF format, reports containing tables that span multiple pages will repeat the data table header on each contiguous page.

Token	Description
General Tokens
[=]	When used as the first three characters, turns the cell into a formula
Units Tokens
[Energy_Units]	The units used for Energy data
[Volume_Units]	The units used for Volume data
[HeatingValueVolume_Units]	The units used for HVV data
[Pressure_Units]	The units used for Pressure data
[Temperature_Units]	The units used for Temperature data

Balance Contribution Report: Received Data Table Tokens

Note: Energy and Volume data cell values have meaning according to the Node type selected, as follows:

Energy values apply for Gas Nodes only; they do not apply for Liquid Nodes.
Volume values for Liquid Nodes are calculated Gas Equivalent Volume (GEV), in accordance with Directive 017. Refer to Appendix 5: Gas Equivalent Volume Determination for more information.

Balance Contribution report data tables, which appear between #SubSection# ReceivedDataTable (1 or 2) and #End#, can be described by the following tokens.

Token	Description
General Tokens
[=]	When used as the first three characters, turns the cell into a formula
[FirstRow]	The row number of the first row in the data table
[RowNumber]	The data row number
[NodeDesc]	The Node description
[NodeName]	The Node name
[NodeType]	The Node type
[NodeStationContribution]	For Station Group Nodes, the station contribution value, whether receipt (+) or delivery (-)
[Energy_Net]	The net Energy gain/loss value
[Volume_Net]	The net Volume gain/loss value
[HeatingValueVolume]	Heating Value Volume value
[Pressure_WeightedAverage]	The weighted average Pressure value for the time span
[Temperature_WeightedAverage]	The weighted average Temperature value for the time span

Balance Contribution Report: Received Data Table Footer Tokens

Balance Contribution report table footers, which appear between #SubSection# ReceivedDataTableFooter and #End#, can be described by the following tokens.

Token	Description
[=]	When used as the first three characters, turns the cell into a formula
[FirstRow]	The row number of the first row in the data table
[LastRow]	The row number of the last row in the data table

Balance Contribution Report: Delivered Report Label Token

Balance Contribution report subsection labels, which appear between #SubSection# DeliveredReportLabel and #End#, can be described by the following tokens.

Token	Description
[DeliveryStationCount]	The number of stations (or liquid device Nodes) with balances delivered

Balance Contribution Report: Delivered Data Table Header Tokens

Balance Contribution report data table headers, which appear between #SubSection# DeliveredDataTableHeader and #End#, can be described by the following tokens.

Note: In PDF format, reports containing tables that span multiple pages will repeat the data table header on each contiguous page.

Token	Description
General Tokens
[=]	When used as the first three characters, turns the cell into a formula
Units Tokens
[Energy_Units]	The units used for Energy data
[Volume_Units]	The units used for Volume data
[HeatingValueVolume_Units]	The units used for HVV data
[Pressure_Units]	The units used for Pressure data
[Temperature_Units]	The units used for Temperature data

Balance Contribution Report: Delivered Data Table Tokens

Note: Energy and Volume data cell values have meaning according to the Node type selected, as follows:

Energy values apply for Gas Nodes only; they do not apply for Liquid Nodes.
Volume values for Liquid Nodes are calculated Gas Equivalent Volume (GEV), in accordance with Directive 017. Refer to Appendix 5: Gas Equivalent Volume Determination for more information.

Balance Contribution report data tables, which appear between #SubSection# DeliveredDataTable (1 or 2) and #End#, can be described by the following tokens.

Token	Description
General Tokens
[=]	When used as the first three characters, turns the cell into a formula
[FirstRow]	The row number of the first row in the data table
[RowNumber]	The data row number
[NodeDesc]	The Node description
[NodeName]	The Node name
[NodeType]	The Node type
[NodeStationContribution]	For Station Group Nodes, the station contribution value, whether receipt (+) or delivery (-)
[Energy_Net]	The net Energy gain/loss value
[Volume_Net]	The net Volume gain/loss value
[HeatingValueVolume]	Heating Value Volume value
[Pressure_WeightedAverage]	The weighted average Pressure value for the time span
[Temperature_WeightedAverage]	The weighted average Temperature value for the time span

Balance Contribution Report: Delivered Data Table Footer Tokens

Balance Contribution report table footers, which appear between #SubSection# DeliveredDataTableFooter and #End#, can be described by the following tokens.

Token	Description
[=]	When used as the first three characters, turns the cell into a formula
[FirstRow]	The row number of the first row in the data table
[LastRow]	The row number of the last row in the data table

Balance Contribution Report: Report Summary Tokens

Balance Overview report summary sections, which appear between #SubSection# ReportSummary and #End#, can be described by the following tokens.

Token	Description
[=]	When used as the first three characters, turns the cell into a formula
[ReceivedSumRow]	The received sum of the Node
[DeliveredSumRow]	The delivered sum of the Node
[TotalStationCount]	The total number of stations (or liquid device Nodes) in the report

Balance Contribution Report: Report Footer

Balance Contribution report footers, which appear between #SubSection# ReportFooter and #End#, can be described by the text you enter. Type the desired text into the cell, and format it as desired.